root / lib / serializer.py @ d833acc6
History | View | Annotate | Download (4.5 kB)
1 | 8d14b30d | Iustin Pop | #
|
---|---|---|---|
2 | 8d14b30d | Iustin Pop | #
|
3 | 8d14b30d | Iustin Pop | |
4 | 8d14b30d | Iustin Pop | # Copyright (C) 2007, 2008 Google Inc.
|
5 | 8d14b30d | Iustin Pop | #
|
6 | 8d14b30d | Iustin Pop | # This program is free software; you can redistribute it and/or modify
|
7 | 8d14b30d | Iustin Pop | # it under the terms of the GNU General Public License as published by
|
8 | 8d14b30d | Iustin Pop | # the Free Software Foundation; either version 2 of the License, or
|
9 | 8d14b30d | Iustin Pop | # (at your option) any later version.
|
10 | 8d14b30d | Iustin Pop | #
|
11 | 8d14b30d | Iustin Pop | # This program is distributed in the hope that it will be useful, but
|
12 | 8d14b30d | Iustin Pop | # WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 | 8d14b30d | Iustin Pop | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 | 8d14b30d | Iustin Pop | # General Public License for more details.
|
15 | 8d14b30d | Iustin Pop | #
|
16 | 8d14b30d | Iustin Pop | # You should have received a copy of the GNU General Public License
|
17 | 8d14b30d | Iustin Pop | # along with this program; if not, write to the Free Software
|
18 | 8d14b30d | Iustin Pop | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 | 8d14b30d | Iustin Pop | # 02110-1301, USA.
|
20 | 8d14b30d | Iustin Pop | |
21 | 8d14b30d | Iustin Pop | """Serializer abstraction module
|
22 | 8d14b30d | Iustin Pop |
|
23 | 8d14b30d | Iustin Pop | This module introduces a simple abstraction over the serialization
|
24 | 8d14b30d | Iustin Pop | backend (currently json).
|
25 | 8d14b30d | Iustin Pop |
|
26 | 8d14b30d | Iustin Pop | """
|
27 | fe267188 | Iustin Pop | # pylint: disable-msg=C0103
|
28 | fe267188 | Iustin Pop | |
29 | fe267188 | Iustin Pop | # C0103: Invalid name, since pylint doesn't see that Dump points to a
|
30 | fe267188 | Iustin Pop | # function and not a constant
|
31 | 8d14b30d | Iustin Pop | |
32 | 8d14b30d | Iustin Pop | import simplejson |
33 | 8d14b30d | Iustin Pop | import re |
34 | f4a2f532 | Guido Trotter | |
35 | f4a2f532 | Guido Trotter | from ganeti import errors |
36 | 615aaaba | Michael Hanselmann | from ganeti import utils |
37 | 071448fb | Michael Hanselmann | |
38 | d357f531 | Michael Hanselmann | |
39 | 8d14b30d | Iustin Pop | _JSON_INDENT = 2
|
40 | 8d14b30d | Iustin Pop | |
41 | e91ffe49 | Michael Hanselmann | _RE_EOLSP = re.compile('[ \t]+$', re.MULTILINE)
|
42 | 8d14b30d | Iustin Pop | |
43 | 8d14b30d | Iustin Pop | |
44 | 02141fb1 | Michael Hanselmann | def _GetJsonDumpers(_encoder_class=simplejson.JSONEncoder): |
45 | d357f531 | Michael Hanselmann | """Returns two JSON functions to serialize data.
|
46 | d357f531 | Michael Hanselmann |
|
47 | d357f531 | Michael Hanselmann | @rtype: (callable, callable)
|
48 | d357f531 | Michael Hanselmann | @return: The function to generate a compact form of JSON and another one to
|
49 | d357f531 | Michael Hanselmann | generate a more readable, indented form of JSON (if supported)
|
50 | d357f531 | Michael Hanselmann |
|
51 | d357f531 | Michael Hanselmann | """
|
52 | 02141fb1 | Michael Hanselmann | plain_encoder = _encoder_class(sort_keys=True)
|
53 | d357f531 | Michael Hanselmann | |
54 | d357f531 | Michael Hanselmann | # Check whether the simplejson module supports indentation
|
55 | d357f531 | Michael Hanselmann | try:
|
56 | 02141fb1 | Michael Hanselmann | indent_encoder = _encoder_class(indent=_JSON_INDENT, sort_keys=True)
|
57 | d357f531 | Michael Hanselmann | except TypeError: |
58 | d357f531 | Michael Hanselmann | # Indentation not supported
|
59 | 02141fb1 | Michael Hanselmann | indent_encoder = plain_encoder |
60 | d357f531 | Michael Hanselmann | |
61 | 02141fb1 | Michael Hanselmann | return (plain_encoder.encode, indent_encoder.encode)
|
62 | d357f531 | Michael Hanselmann | |
63 | d357f531 | Michael Hanselmann | |
64 | d357f531 | Michael Hanselmann | (_DumpJson, _DumpJsonIndent) = _GetJsonDumpers() |
65 | d357f531 | Michael Hanselmann | |
66 | d357f531 | Michael Hanselmann | |
67 | 071448fb | Michael Hanselmann | def DumpJson(data, indent=True): |
68 | 8d14b30d | Iustin Pop | """Serialize a given object.
|
69 | 8d14b30d | Iustin Pop |
|
70 | c41eea6e | Iustin Pop | @param data: the data to serialize
|
71 | c41eea6e | Iustin Pop | @param indent: whether to indent output (depends on simplejson version)
|
72 | c41eea6e | Iustin Pop |
|
73 | c41eea6e | Iustin Pop | @return: the string representation of data
|
74 | 071448fb | Michael Hanselmann |
|
75 | 8d14b30d | Iustin Pop | """
|
76 | d357f531 | Michael Hanselmann | if indent:
|
77 | d357f531 | Michael Hanselmann | fn = _DumpJsonIndent |
78 | 8d14b30d | Iustin Pop | else:
|
79 | d357f531 | Michael Hanselmann | fn = _DumpJson |
80 | 071448fb | Michael Hanselmann | |
81 | d357f531 | Michael Hanselmann | txt = _RE_EOLSP.sub("", fn(data))
|
82 | 8d14b30d | Iustin Pop | if not txt.endswith('\n'): |
83 | 8d14b30d | Iustin Pop | txt += '\n'
|
84 | d357f531 | Michael Hanselmann | |
85 | 8d14b30d | Iustin Pop | return txt
|
86 | 8d14b30d | Iustin Pop | |
87 | 8d14b30d | Iustin Pop | |
88 | 228538cf | Michael Hanselmann | def LoadJson(txt): |
89 | 8d14b30d | Iustin Pop | """Unserialize data from a string.
|
90 | 8d14b30d | Iustin Pop |
|
91 | c41eea6e | Iustin Pop | @param txt: the json-encoded form
|
92 | c41eea6e | Iustin Pop |
|
93 | c41eea6e | Iustin Pop | @return: the original data
|
94 | c41eea6e | Iustin Pop |
|
95 | 8d14b30d | Iustin Pop | """
|
96 | 8d14b30d | Iustin Pop | return simplejson.loads(txt)
|
97 | 228538cf | Michael Hanselmann | |
98 | 228538cf | Michael Hanselmann | |
99 | 72ca1dcb | Balazs Lecz | def DumpSignedJson(data, key, salt=None, key_selector=None): |
100 | f4a2f532 | Guido Trotter | """Serialize a given object and authenticate it.
|
101 | f4a2f532 | Guido Trotter |
|
102 | f4a2f532 | Guido Trotter | @param data: the data to serialize
|
103 | f4a2f532 | Guido Trotter | @param key: shared hmac key
|
104 | 72ca1dcb | Balazs Lecz | @param key_selector: name/id that identifies the key (in case there are
|
105 | 72ca1dcb | Balazs Lecz | multiple keys in use, e.g. in a multi-cluster environment)
|
106 | f4a2f532 | Guido Trotter | @return: the string representation of data signed by the hmac key
|
107 | f4a2f532 | Guido Trotter |
|
108 | f4a2f532 | Guido Trotter | """
|
109 | f4a2f532 | Guido Trotter | txt = DumpJson(data, indent=False)
|
110 | f4a2f532 | Guido Trotter | if salt is None: |
111 | f4a2f532 | Guido Trotter | salt = ''
|
112 | f4a2f532 | Guido Trotter | signed_dict = { |
113 | f4a2f532 | Guido Trotter | 'msg': txt,
|
114 | f4a2f532 | Guido Trotter | 'salt': salt,
|
115 | 3718bf6d | Michael Hanselmann | } |
116 | 3718bf6d | Michael Hanselmann | |
117 | 72ca1dcb | Balazs Lecz | if key_selector:
|
118 | 72ca1dcb | Balazs Lecz | signed_dict["key_selector"] = key_selector
|
119 | 72ca1dcb | Balazs Lecz | else:
|
120 | 3718bf6d | Michael Hanselmann | key_selector = ""
|
121 | 3718bf6d | Michael Hanselmann | |
122 | 3718bf6d | Michael Hanselmann | signed_dict["hmac"] = utils.Sha1Hmac(key, txt, salt=salt + key_selector)
|
123 | 72ca1dcb | Balazs Lecz | |
124 | 40765aa0 | Guido Trotter | return DumpJson(signed_dict, indent=False) |
125 | f4a2f532 | Guido Trotter | |
126 | f4a2f532 | Guido Trotter | |
127 | 4e9dac14 | Guido Trotter | def LoadSignedJson(txt, key): |
128 | f4a2f532 | Guido Trotter | """Verify that a given message was signed with the given key, and load it.
|
129 | f4a2f532 | Guido Trotter |
|
130 | f4a2f532 | Guido Trotter | @param txt: json-encoded hmac-signed message
|
131 | 72ca1dcb | Balazs Lecz | @param key: the shared hmac key or a callable taking one argument (the key
|
132 | 72ca1dcb | Balazs Lecz | selector), which returns the hmac key belonging to the key selector.
|
133 | 72ca1dcb | Balazs Lecz | Typical usage is to pass a reference to the get method of a dict.
|
134 | f4a2f532 | Guido Trotter | @rtype: tuple of original data, string
|
135 | 4e9dac14 | Guido Trotter | @return: original data, salt
|
136 | f4a2f532 | Guido Trotter | @raises errors.SignatureError: if the message signature doesn't verify
|
137 | f4a2f532 | Guido Trotter |
|
138 | f4a2f532 | Guido Trotter | """
|
139 | f4a2f532 | Guido Trotter | signed_dict = LoadJson(txt) |
140 | f4a2f532 | Guido Trotter | if not isinstance(signed_dict, dict): |
141 | f4a2f532 | Guido Trotter | raise errors.SignatureError('Invalid external message') |
142 | f4a2f532 | Guido Trotter | try:
|
143 | f4a2f532 | Guido Trotter | msg = signed_dict['msg']
|
144 | f4a2f532 | Guido Trotter | salt = signed_dict['salt']
|
145 | f4a2f532 | Guido Trotter | hmac_sign = signed_dict['hmac']
|
146 | f4a2f532 | Guido Trotter | except KeyError: |
147 | f4a2f532 | Guido Trotter | raise errors.SignatureError('Invalid external message') |
148 | f4a2f532 | Guido Trotter | |
149 | 72ca1dcb | Balazs Lecz | if callable(key): |
150 | fe7c59d5 | Guido Trotter | # pylint: disable-msg=E1103
|
151 | 72ca1dcb | Balazs Lecz | key_selector = signed_dict.get("key_selector", None) |
152 | 72ca1dcb | Balazs Lecz | hmac_key = key(key_selector) |
153 | 72ca1dcb | Balazs Lecz | if not hmac_key: |
154 | 72ca1dcb | Balazs Lecz | raise errors.SignatureError("No key with key selector '%s' found" % |
155 | 72ca1dcb | Balazs Lecz | key_selector) |
156 | 72ca1dcb | Balazs Lecz | else:
|
157 | 72ca1dcb | Balazs Lecz | key_selector = ""
|
158 | 72ca1dcb | Balazs Lecz | hmac_key = key |
159 | 72ca1dcb | Balazs Lecz | |
160 | 3718bf6d | Michael Hanselmann | if not utils.VerifySha1Hmac(hmac_key, msg, hmac_sign, |
161 | 3718bf6d | Michael Hanselmann | salt=salt + key_selector): |
162 | f4a2f532 | Guido Trotter | raise errors.SignatureError('Invalid Signature') |
163 | f4a2f532 | Guido Trotter | |
164 | 4e9dac14 | Guido Trotter | return LoadJson(msg), salt
|
165 | f4a2f532 | Guido Trotter | |
166 | f4a2f532 | Guido Trotter | |
167 | 228538cf | Michael Hanselmann | Dump = DumpJson |
168 | 228538cf | Michael Hanselmann | Load = LoadJson |
169 | f4a2f532 | Guido Trotter | DumpSigned = DumpSignedJson |
170 | f4a2f532 | Guido Trotter | LoadSigned = LoadSignedJson |