File Explorer

1# Copyright (C) 2016-2017 g10 Code GmbH2# Copyright (C) 2004 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/or6#    modify it under the terms of the GNU Lesser General Public7#    License as published by the Free Software Foundation; either8#    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 of12#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU13#    Lesser General Public License for more details.14#15#    You should have received a copy of the GNU Lesser General Public16#    License along with this library; if not, write to the Free Software17#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA18 19from __future__ import absolute_import, print_function, unicode_literals20 21from . import gpgme22from . import util23 24del absolute_import, print_function, unicode_literals25 26# To appease static analysis tools, we define some constants here.27# They are overwritten with the proper values by process_constants.28NO_ERROR = None29EOF = None30 31util.process_constants('GPG_ERR_', globals())32del util33 34 35class GpgError(Exception):36    """A GPG Error37 38    This is the base of all errors thrown by this library.39 40    If the error originated from GPGME, then additional information41    can be found by looking at 'code' for the error code, and 'source'42    for the errors origin.  Suitable constants for comparison are43    defined in this module.  'code_str' and 'source_str' are44    human-readable versions of the former two properties.45 46    If 'context' is not None, then it contains a human-readable hint47    as to where the error originated from.48 49    If 'results' is not None, it is a tuple containing results of the50    operation that failed.  The tuples elements are the results of the51    function that raised the error.  Some operations return results52    even though they signal an error.  Of course this information must53    be taken with a grain of salt.  But often, this information is54    useful for diagnostic uses or to give the user feedback.  Since55    the normal control flow is disrupted by the exception, the callee56    can no longer return results, hence we attach them to the57    exception objects.58 59    """60 61    def __init__(self, error=None, context=None, results=None):62        self.error = error63        self.context = context64        self.results = results65 66    @property67    def code(self):68        if self.error is None:69            return None70        return gpgme.gpgme_err_code(self.error)71 72    @property73    def code_str(self):74        if self.error is None:75            return None76        return gpgme.gpgme_strerror(self.error)77 78    @property79    def source(self):80        if self.error is None:81            return None82        return gpgme.gpgme_err_source(self.error)83 84    @property85    def source_str(self):86        if self.error is None:87            return None88        return gpgme.gpgme_strsource(self.error)89 90    def __str__(self):91        msgs = []92        if self.context is not None:93            msgs.append(self.context)94        if self.error is not None:95            msgs.append(self.source_str)96            msgs.append(self.code_str)97        return ': '.join(msgs)98 99 100class GPGMEError(GpgError):101    '''Generic error102 103    This is a generic error that wraps the underlying libraries native104    error type.  It is thrown when the low-level API is invoked and105    returns an error.  This is the error that was used in PyME.106 107    '''108 109    @classmethod110    def fromSyserror(cls):111        return cls(gpgme.gpgme_err_code_from_syserror())112 113    @property114    def message(self):115        return self.context116 117    def getstring(self):118        return str(self)119 120    def getcode(self):121        return self.code122 123    def getsource(self):124        return self.source125 126 127def errorcheck(retval, extradata=None):128    if retval:129        raise GPGMEError(retval, extradata)130 131 132class KeyNotFound(GPGMEError, KeyError):133    """Raised if a key was not found134 135    GPGME indicates this condition with EOF, which is not very136    idiomatic.  We raise this error that is both a GPGMEError137    indicating EOF, and a KeyError.138 139    """140 141    def __init__(self, keystr):142        self.keystr = keystr143        GPGMEError.__init__(self, EOF)144 145    def __str__(self):146        return self.keystr147 148 149# These errors are raised in the idiomatic interface code.150 151 152class EncryptionError(GpgError):153    pass154 155 156class InvalidRecipients(EncryptionError):157    def __init__(self, recipients, **kwargs):158        EncryptionError.__init__(self, **kwargs)159        self.recipients = recipients160 161    def __str__(self):162        return ", ".join("{}: {}".format(r.fpr, gpgme.gpgme_strerror(r.reason))163                         for r in self.recipients)164 165 166class DecryptionError(GpgError):167    pass168 169 170class UnsupportedAlgorithm(DecryptionError):171    def __init__(self, algorithm, **kwargs):172        DecryptionError.__init__(self, **kwargs)173        self.algorithm = algorithm174 175    def __str__(self):176        return self.algorithm177 178 179class SigningError(GpgError):180    pass181 182 183class InvalidSigners(SigningError):184    def __init__(self, signers, **kwargs):185        SigningError.__init__(self, **kwargs)186        self.signers = signers187 188    def __str__(self):189        return ", ".join("{}: {}".format(s.fpr, gpgme.gpgme_strerror(s.reason))190                         for s in self.signers)191 192 193class VerificationError(GpgError):194    def __init__(self, result, **kwargs):195        GpgError.__init__(self, **kwargs)196        self.result = result197 198 199class BadSignatures(VerificationError):200    def __str__(self):201        return ", ".join("{}: {}".format(s.fpr, gpgme.gpgme_strerror(s.status))202                         for s in self.result.signatures203                         if s.status != NO_ERROR)204 205 206class MissingSignatures(VerificationError):207    def __init__(self, result, missing, **kwargs):208        VerificationError.__init__(self, result, **kwargs)209        self.missing = missing210 211    def __str__(self):212        return ", ".join(k.subkeys[0].fpr for k in self.missing)213