Add basic openpgp key handling to Key Manager
[leap_pycommon.git] / src / leap / common / keymanager / openpgp.py
1 # -*- coding: utf-8 -*-
2 # openpgpwrapper.py
3 # Copyright (C) 2013 LEAP
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This program 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
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18
19 """
20 Infrastructure for using OpenPGP keys in Key Manager.
21 """
22
23
24 import re
25
26 from leap.common.keymanager.errors import (
27     KeyNotFound,
28     KeyAlreadyExists,
29 )
30 from leap.common.keymanager.keys import (
31     EncryptionKey,
32     KeyTypeWrapper,
33 )
34 from leap.common.keymanager.gpg import GPGWrapper
35
36
37 class OpenPGPKey(EncryptionKey):
38     """
39     Base class for OpenPGP keys.
40     """
41
42
43 class OpenPGPWrapper(KeyTypeWrapper):
44     """
45     A wrapper for OpenPGP keys.
46     """
47
48     def __init__(self, gnupghome=None):
49         self._gpg = GPGWrapper(gnupghome=gnupghome)
50
51     def _build_key(self, address, result):
52         """
53         Build an OpenPGPWrapper key for C{address} based on C{result} from
54         local storage.
55
56         @param address: The address bound to the key.
57         @type address: str
58         @param result: Result obtained from GPG storage.
59         @type result: dict
60         """
61         key_data = self._gpg.export_keys(result['fingerprint'], secret=False)
62         return OpenPGPKey(
63             address,
64             key_id=result['keyid'],
65             fingerprint=result['fingerprint'],
66             key_data=key_data,
67             length=result['length'],
68             expiry_date=result['expires'],
69             validation=None,  # TODO: verify for validation.
70         )
71
72     def gen_key(self, address):
73         """
74         Generate an OpenPGP keypair for C{address}.
75
76         @param address: The address bound to the key.
77         @type address: str
78         @return: The key bound to C{address}.
79         @rtype: OpenPGPKey
80         @raise KeyAlreadyExists: If key already exists in local database.
81         """
82         try:
83             self.get_key(address)
84             raise KeyAlreadyExists()
85         except KeyNotFound:
86             pass
87         params = self._gpg.gen_key_input(
88             key_type='RSA',
89             key_length=4096,
90             name_real=address,
91             name_email=address,
92             name_comment='Generated by LEAP Key Manager.')
93         self._gpg.gen_key(params)
94         return self.get_key(address)
95
96     def get_key(self, address):
97         """
98         Get key bound to C{address} from local storage.
99
100         @param address: The address bound to the key.
101         @type address: str
102
103         @return: The key bound to C{address}.
104         @rtype: OpenPGPKey
105         @raise KeyNotFound: If the key was not found on local storage.
106         """
107         m = re.compile('.*<%s>$' % address)
108         keys = self._gpg.list_keys(secret=False)
109
110         def bound_to_address(key):
111              return bool(filter(lambda u: m.match(u), key['uids']))
112
113         try:
114             bound_key = filter(bound_to_address, keys).pop()
115             return self._build_key(address, bound_key)
116         except IndexError:
117             raise KeyNotFound(address)
118
119     def put_key(self, data):
120         """
121         Put key contained in {data} in local storage.
122
123         @param key: The key data to be stored.
124         @type key: str
125         """
126         self._gpg.import_keys(data)