File: base.py

package info (click to toggle)
gajim-openpgp 1.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 160 kB
  • sloc: python: 1,487; sh: 29; xml: 11; makefile: 2
file content (95 lines) | stat: -rw-r--r-- 2,679 bytes parent folder | download
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
# Copyright (C) 2025 Philipp Hörist <philipp AT hoerist.com>
#
# This file is part of the OpenPGP Gajim Plugin.
#
# OpenPGP Gajim Plugin is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation; version 3 only.
#
# OpenPGP Gajim Plugin is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with OpenPGP Gajim Plugin. If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations

from typing import TYPE_CHECKING

from collections.abc import Sequence
from pathlib import Path

from nbxmpp.protocol import JID

if TYPE_CHECKING:
    from openpgp.modules.key_store import KeyData


class BaseKeyringItem:
    def __init__(self) -> None:
        self._uid = self._get_uid()

    @property
    def is_xmpp_key(self) -> bool:
        try:
            return self.jid is not None
        except Exception:
            return False

    def is_valid(self, jid: JID) -> bool:
        if not self.is_xmpp_key:
            return False
        return jid == self.jid

    def _get_uid(self) -> str | None:
        raise NotImplementedError

    @property
    def fingerprint(self) -> str:
        raise NotImplementedError

    @property
    def uid(self):
        if self._uid is not None:
            return self._uid

    @property
    def jid(self) -> JID | None:
        if self._uid is not None:
            return JID.from_string(self._uid)

    def __hash__(self):
        return hash(self.fingerprint)


class BasePGPBackend:
    def __init__(self, jid: str, gnupghome: Path) -> None:
        raise NotImplementedError

    def generate_key(self) -> None:
        raise NotImplementedError

    def encrypt(
        self, payload: bytes, keys: list[KeyData]
    ) -> tuple[bytes | None, str | None]:
        raise NotImplementedError

    def decrypt(self, payload: bytes) -> tuple[str, str]:
        raise NotImplementedError

    def get_keys(self) -> Sequence[BaseKeyringItem]:
        raise NotImplementedError

    def import_key(self, data: bytes, jid: JID) -> BaseKeyringItem | None:
        raise NotImplementedError

    def get_own_key_details(self) -> tuple[str | None, int | None]:
        raise NotImplementedError

    def export_key(self, fingerprint: str) -> bytes | None:
        raise NotImplementedError

    def delete_key(self, fingerprint: str) -> None:
        raise NotImplementedError